# SpeedoMeter.Game


# Methods

## `GetBestOfAllSpeed`

Returns the best of all players speed record.

**Signature:**

```Lua
SpeedoMeter.Game:GetBestOfAllSpeed()
```

**Returns:** (Float) The best speed record value.

**Parameters:** None.

# Subroutines

## OnUpdate hook

Internal essential function.

If you are overriding `Game.Rule:OnUpdate`, then calls this function inside of it.

Failed to do so causing the library malfunction.

This subroutine already included `SpeedoMeter.Game:OnUpdate` so no need to calls it again.

**Signature:**

```Lua
SpeedoMeter.Game:OnUpdate_SpeedRecord( time );
```


# SpeedoMeter.UI


# Methods

## `GetBestSpeed`

Returns the player's best speed record.

**Signature:**

```Lua
SpeedoMeter.UI:GetBestSpeed()
```

**Returns:**

* (Float) The player's best speed.

**Parameters:** None.


## `GetBestOfAllSpeed`

Returns the best of all players speed record.

**Signature:**

```Lua
SpeedoMeter.UI:GetBestOfAllSpeed()
```

**Returns:**

* (Float) The best speed.

**Parameters:** None.


## `explode`

Explodes a string into a table.

**Signature:**

```Lua
SpeedoMeter.UI:explode( source , delimiter )
```

**Returns:**

* (Table) The exploded string.

**Parameters:**

1. (String) The string value to explode.

2. (String) The delimiter.


# Subroutines

# Subroutines

## OnUpdate hook

Internal essential function.

If you are overriding `UI.Event:OnUpdate`, then calls this function inside of it.

Failed to do so causing the library malfunction.

**Signature:**

```Lua
SpeedoMeter.UI:OnUpdate_SpeedRecord();
```


# SpeedoMeter.SyncValue


# Properties

| Data Type | Property Name | Default Value | Description |
| --- | --- | --- | --- |
| String | `SpeedoMeter.SyncValue.PlayerSpeedBestAll.NAME` | "SoM.Speed.BestAll" | `PlayerSpeedBestAll` sync variable name format. |
| SyncValue object | `SpeedoMeter.SyncValue.PlayerSpeedBestAll.Instance` | nil | Instance of `PlayerSpeedBestAll` sync variable name. |

